Skip to main content

New-IMSharedLink

SYNOPSIS​

Creates a new shared link for assets or albums.

SYNTAX​

asset (Default)​

New-IMSharedLink [-Session <ImmichSession>] -AssetId <String[]> [-AllowDownload] [-AllowUpload]
 [-Description <String>] [-ExpiresAt <DateTime>] [-ShowMetadata] [-Password <SecureString>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

album​

New-IMSharedLink [-Session <ImmichSession>] -AlbumId <String> [-AllowDownload] [-AllowUpload]
 [-Description <String>] [-ExpiresAt <DateTime>] [-ShowMetadata] [-Password <SecureString>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Generates public sharing links with configurable permissions and expiration.

EXAMPLES​

EXAMPLE 1​

New-IMSharedLink

New Immich shared link

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AssetId​

Asset IDs to include in the shared link.

Type: String[]
Parameter Sets: asset
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-AlbumId​

Album ID to share via the link.

Type: String
Parameter Sets: album
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllowDownload​

Permits downloading assets through the shared link.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AllowUpload​

Permits uploading assets through the shared link.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Description​

Description text for the shared link.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExpiresAt​

Defines an expiration date of the shared link

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowMetadata​

Defines if asset metadata is shown

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Password​

Defines a password for the shared link

Type: SecureString
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github